-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(static-renderer): add @tiptap/static-renderer
to enable static rendering of content
#5528
base: develop
Are you sure you want to change the base?
Conversation
|
✅ Deploy Preview for tiptap-embed ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
2162826
to
64dae06
Compare
const schema = getSchema([StarterKit]) | ||
|
||
console.log( | ||
renderToStaticMarkup( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is just a demo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Awesome idea @nperez0111
@tiptap/static-renderer
to enable static rendering of content
Just as a note, if we render to something like jsx-dom then we can render directly to HTMLElements with pure JS & prosemirror |
@nperez0111 I am super excited about this PR (finally took a look at it over the weekend). I tried building it locally today to test it out, and it failed because there was no Edit: Ah, its the same error currently failing the build CI step. You are probably already aware of this then! |
Yep, this isn't completely prime-time yet. Needs a lot more tests to ensure things actually work |
@tiptap/static-renderer
The
@tiptap/static-renderer
package provides a way to render a Tiptap/ProseMirror document to any target format, like an HTML string, a React component, or even markdown.Why Static Render?
The main use case for static rendering is to render a Tiptap/ProseMirror document on the server-side, for example in a Next.js or Nuxt.js application. This way, you can render the content of your editor to HTML before sending it to the client, which can improve the performance of your application.
Another use case is to render the content of your editor to another format like markdown, which can be useful if you want to send it to a markdown-based API.
But what makes it static? The static renderer doesn't require a browser or a DOM to render the content. It's a pure JavaScript function that takes a document (as JSON or Prosemirror Node instance) and returns the target format back.
Example
Render a Tiptap document to an HTML string:
Render to a React component:
There are a number of options available to customize the output, like custom node and mark mappings, or handling unhandled nodes and marks.
API
renderToHTMLString
renderToHTMLString
Optionsextensions
: An array of Tiptap extensions that are used to render the content.content
: The content to render. Can be a Prosemirror Node instance or a JSON representation of a Prosemirror document.options
: An object with additional options.options.nodeMapping
: An object that maps Prosemirror nodes to HTML strings.options.markMapping
: An object that maps Prosemirror marks to HTML strings.options.unhandledNode
: A function that is called when an unhandled node is encountered.options.unhandledMark
: A function that is called when an unhandled mark is encountered.renderToReactElement
renderToReactElement
Optionsextensions
: An array of Tiptap extensions that are used to render the content.content
: The content to render. Can be a Prosemirror Node instance or a JSON representation of a Prosemirror document.options
: An object with additional options.options.nodeMapping
: An object that maps Prosemirror nodes to React components.options.markMapping
: An object that maps Prosemirror marks to React components.options.unhandledNode
: A function that is called when an unhandled node is encountered.options.unhandledMark
: A function that is called when an unhandled mark is encountered.How does it work?
Each Tiptap node/mark extension can define a
renderHTML
method which is used to generate default mappings of Prosemirror nodes/marks to the target format. These can be overridden by providing custom mappings in the options. One thing to note is that the static renderer doesn't support node views automatically, so you need to provide a mapping for each node type that you want rendered as a node view. Here is an example of how you can render a node view as a React component:But what if you want to render the rich text content of the node view? You can do that by providing a
NodeViewContent
component as a child of the node view component: